How to create records using Record Templates

The Record Template utility can be used to create a batch of records based on an existing record.

  1. Search for or otherwise list a group of records.

    As the purpose of the Record Templates utility is to create a series of records based on an existing record, the first step is to retrieve one or more records. Any means may be used to retrieve the record to be used as the source record (the record from which values are to be extracted).

  2. Make the source record the current record.
  3. Select Tools>Templates from the Menu bar to display the Record Templates box with a list of pre-defined Record Templates.
  4. Select a Record Template from the list and click OK.

    The Record Template Wizard displays:

    Specify the following:

    • Number of records to create

      Enter the number of records to be created when the Wizard is completed. There may be a maximum number of records that may be created: the limit is set by the creator of the Record Template. If a limit has been set, a hint will appear next to the box into which the record count is entered (as above).

    • Starting IRN

      Enter the IRN (Internal Record Number) of the first record to be created. Subsequent numbers will be given to each new record. If a starting IRN is not specified, the next available number will be used. A Template creator may choose to hide this setting, in which case the next available number is always used.

  5. Click Next to continue.

    The Input Values screen displays:

    Input Values screens are where the data to be inserted into the new records is specified. The exact layout of the screen will vary depending on what information the Template creator wants to use. The screen has four elements:

    • Input field

      This is the Vitalware field into which the entered value will be added. The text displayed is the prompt of the field followed in brackets by the field group in which it appears.

    • Input prompt

      To the left of the input text box a prompt can be found indicating the type of value to be entered (Enter the Receipt Text in the example above). The creator of the Template specifies what prompt is displayed.

    • Input text box

      Enter the value to be inserted in the record created. The input text box may be single or multi-lined as defined by the Template creator. The creator may also indicate what type of data should be entered (text, integer or float) and whether a value is mandatory.

    • Input help

      This is a help message specified by the Template creator and designed to provide more information about, and examples of, the input value (Enter the text that will display on the receipt in the picture above). The input help is optional and will not appear on the Input Values screen if not defined by the Template creator.

  6. Click Next to continue.

    A number of Input Value screens may be displayed depending on how many input values are required for the created records. Input values may also be used to request the starting value for fields that contain incrementing data.

    For example, a Booking Number may consist of the current year followed by a number within the year (e.g. 2008.23, 2006.154, etc.). An input value may ask for the year on one screen and the starting number within the year on the next screen. When the records are created, numbers will be allocated sequentially from the starting number for the supplied year. Using this mechanism it is easy to pre-allocate a batch of Booking Number to a set of records.

  7. Click Next to move through all the Input Value screens.

    The Settings screen displays:

    This is a summary of the number of records to be created, the starting IRN and any input values. Click Back if necessary to amend any details.

  8. Click Next to continue.

    The Creating screen displays:

    The records are now created. A gauge provides a visual indicator of creation progress. The numbers of records created and errors encountered are displayed.

    If an error occurs, the creation process is halted and a message displays:

    • Click Abort to end the creation process without further records being created

      -OR-

    • Click Ignore to move on to the creation of the next record.
  9. Click Finished once the records are created.

    The Template Creation Complete screen displays:

    Specify the following:

    • View Template Creation Report

      Select whether a report listing the records created will be shown.

    • Click Close to finish the creation process. If View Template Creation Report was selected, a report displays:
   Template record creation started 24 Oct 2008 11:00:16
      Number of records to create: 10
   Starting IRN: Next available IRN
   Input field "Receipt Text: (Product Details)"
      Value: Commemorative Certificate
   Record 1, created (irn: 24)
   Record 2, created (irn: 25)
   Record 3, created (irn: 26)
   Record 4, created (irn: 27)
   Record 5, created (irn: 28)
   Record 6, created (irn: 29)
   Record 7, created (irn: 30)
   Record 8, created (irn: 31)
   Record 9, created (irn: 32)
   Record 10, created (irn: 33)
   Number of errors: 0
   Number of records created: 10
   Template record creation finished 24 Oct 2008 11:00:19

The records created are added to the records currently displayed. They are placed immediately after the current record, so that moving forward one record will display the first of the new records.